-
Notifications
You must be signed in to change notification settings - Fork 908
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add ActionCodeSettings.linkDomain and deprecate ActionCodeSettings.dynamicLinkDomain #8738
Conversation
🦋 Changeset detectedLatest commit: 1eda647 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Changeset File Check ✅
|
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1Affected Products
Test Logs |
@@ -513,8 +513,18 @@ export interface ActionCodeSettings { | |||
* | |||
* | |||
* @defaultValue The first domain is automatically selected. | |||
* | |||
* @deprecated Firebase Dynamic Links is deprecated. Migrate to use Firebase Hosting link and use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hsubox76 @DellaBitta Is this the correct way to mark an API as deprecated?
Using @deprecated
generates "Warning: This API is now obsolete" in the refdocs, as shown in this example. But,I agree with @rachelsaunders's comment that "obsolete" isn't the right word.
On the other hand, simply put "Deprecated." (no @ tag) will not make it stand out in the refdocs, as shown in this example, and developers probably won't see the deprecated warning during build time when using this API.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussed offline.
The This API is now obsolete
text comes from the api-documenter tool, not from us. We should continue to use the @deprecated
tag to have a consistent, official marker that is easier to track and find. In addition, we should also put "Deprecated" (and some more explanatory text) in the comment text so that we can provide more detailed explanations in the documentation, in addition to the "This API is now obsolete" message.
Vertex AI Mock Responses Check
|
* Add linkDomain field to ActionCodeSettings * Update API reports * Update error message for ERROR_INVALID_HOSTING_LINK_DOMAIN to include that default hosting domains cannot be used. * Use constants for test values --------- Co-authored-by: NhienLam <[email protected]>
* Implement Integration test for passwordless email sign-in via firebase-hosting links. * Add license to new test file created' did not match any files * Remove unwanted _
f3842c3
to
ebac8bc
Compare
TotpMultiFactorGenerator, | ||
TotpSecret, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to be the only Totp
change int his PR. Is its removal on purpose?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the removal is intentional because it's unused.
Firebase Auth relies on Firebase Dynamic Links (FDL) for mobile out-of-band email action flows. As FDL is deprecated, we're introducing a new solution, Firebase Hosting links, to replace FDL usage in Firebase Auth.
Add a new
ActionCodeSettings.linkDomain
property to customize the Firebase Hosting link domain that is used in out-of-band email action flows.Deprecate
ActionCodeSettings.dynamicLinkDomain
. Migrate to use Firebase Hosting link and useActionCodeSettings.linkDomain
to set a custom domain instead.Migration guide and public documentations will be available after the SDK release.